post /mint/organizations/{org_name}/monetization-packages

Creates an API package.

An API package is a collection of API products that is presented to developers as a bundle, and typically associated with one or more rate plans for monetization. An API package does not become visible to developers until you publish a rate plan for the package (with a start date of the current or future date).

Developers can register their apps to use an API package only by purchasing one of the rate plans currently in effect. If an API package does not have a published rate plan that is currently in effect, the package is not monetized.

You can create multiple API packages. You decide which API products to include in each API package. You can even put the same API product or products in different packages and associate them with the same or different rate plans.

After you add an API product to a package, you may need to set up price points for the API product. You need to do this only if all of the following are true:

  • You set up a revenue sharing rate plan for the API product.
  • Developers charge third parties for the use of the resources in the API product.
  • There is a minimum or maximum restriction on the amount developers can charge and you want to notify developers of the restriction.

The minimum and maximum prices are displayed in the details for the API package.

See also Creating an API product bundle using the API.

Note: Once you create a package, you cannot delete it.

HTTP request

https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages

Path Parameters

org_name (required)

string

Organization name.

Request Body

API package details.

application/json
APIPackage
description (required)

string

Description of the API package.

displayName (required)

string

User-friendly display name for the API package.

id

string

Output only. ID of the API package.

name (required)

string

Name of the API package.

organization

object

id

string

ID of the organization.

product (required)

array

List of API products to include in the API package.

object
id

string

ID of the API product.

status (required)

string

Status indicator for the API package. Valid values include: CREATED, ACTIVE , INACTIVE`.

Note: This value is maintained but not currently used by the API package.

Response Types

201: 

Created

Body

application/json
APIPackage
description (required)

string

Description of the API package.

displayName (required)

string

User-friendly display name for the API package.

id

string

Output only. ID of the API package.

name (required)

string

Name of the API package.

organization

object

id

string

ID of the organization.

product (required)

array

List of API products to include in the API package.

object
id

string

ID of the API product.

status (required)

string

Status indicator for the API package. Valid values include: CREATED, ACTIVE , INACTIVE`.

Note: This value is maintained but not currently used by the API package.

Authentication Requirements

Available Authentication Options
  • Basic
  • OAuth

Try this API

Request parameters
org_name
Request body
For suggestions, press control+space or click one of the blue "add" circles.
Credentials
Multi-factor authentication is not supported.